ParameterFieldDefinition Object

The ParameterFieldDefinition Object represents a parameter field in the report. This object provides properties and methods for retrieving information and setting options for a parameter field in your report (that is, current value, default value, etc.). A ParameterFieldDefinition Object is obtain from the Field property of the FieldObject Object, when the specified field is a parameter field or from the ParameterFieldDefinitions Collection Object under Report.

ParameterFieldDefinition Object Properties

Property Description Read/ Write Restriction in
event handler

DisallowEditing

Boolean. Gets or sets the disallowing editing option.

Read/Write

Can be written only when formatting idle.

DiscreteOrRange
Kind

CRDiscreteOrRangeKind. Gets or sets the parameter value kind (discrete and/or range).

Read/Write

Can be written only when formatting idle.

EditMask

String. Gets or sets edit mask for string parameter. See Remarks below for additional information.

Read/Write

Can be written only when formatting idle.

EnableExclusive
Group

Boolean. Works in conjunction with property PlaceInGroup. If EnableExclusiveGroup is TRUE, a Bool parameter group can have only one value set to TRUE; if FALSE, then the group can have multiple values set to TRUE.

Read/Write

Can be written only when formatting idle.

EnableMultiple
Values

Boolean. Gets or sets the allow multiple values option.

Read/Write

Can be written only when formatting idle.

EnableNullValue

Boolean. Gets or sets the value nullable option for Stored Procedure parameters.

Read/Write

Can be written only when formatting idle.

EnableRangeLimit

Boolean. Gets or sets the option which specifies if this parameter field value should be in the specified range.

Read/Write

Can be written only when formatting idle.

EnableShow
DescriptionOnly

Boolean. Gets or sets the show description for pick list option.

Read/Write

Can be written only when formatting idle.

EnableSortBasedOn
Desc

Boolean. Gets or sets the sort based on description in pick list option.

Read/Write

Can be written only when formatting idle.

GroupNumber

Integer. Gets or sets boolean group number.

Read/Write

Can be written only when formatting idle.

IsCurrentValueSet

Boolean. Gets whether the current value has been set.

Read only

None

IsDefaultValueSet

Boolean. Gets whether the default value has been set.

Read only

None

Kind

CRFieldKind. Gets which kind of field (database, summary, formula, etc.).

Read only

None

MaximumValue

Variant. Gets or sets the maximum value. See Remarks below for additional comments.

Read/Write

Can be written only when formatting idle.

MinimumValue

Variant. Gets or sets minimum value. See Remarks below for additional comments.

Read/Write

Can be written only when formatting idle.

Name

String. Gets the unique formula name of the parameter field as it appears in the Parameter Field list (RDC DataView).

Read only

None

NeedsCurrentValue

Boolean. Gets whether the field needs a current value.

Read only

None

NextValue

Variant. Gets the next field value.

Read only

Can be read only when top-level Report object is formatting active.

NthValue
Description (index
As Integer)

String. Gets or sets nth value description.

Read/Write

Can be written only when formatting idle.

NumberOfBytes

Integer. Gets the number of bytes required to store the field data in memory.

Read only

None

NumberOfCurrent
Ranges

Integer. Gets total number of current ranges.

Read only

None

NumberOfCurrent
Values

Integer. Gets the total number of current values.

Read only

None

NumberOfDefault
Values

Integer. Gets the total number of default values.

Read only

None

ParameterField
Name

String. Gets the name of the parameter field as it is displayed (referenced) in the report (RDC DataView).

Read only

None

ParameterType

CRParameterFieldType. Gets parameter type.

Read only

None

Parent

Report Object. Gets reference to the parent object.

Read only

None

PickListSortMethod

CRParameterPickListSortMethod. Gets or sets the sort method in pick list option.

Read/Write

Can be written only when formatting idle.

PlaceInGroup

Boolean. Gets or sets, when prompting for values, whether a Boolean parameter field should appear as part of a Boolean parameter group or individually. Used in conjunction with Boolean property EnableExclusiveGroup.

Read/Write

Can be written only when formatting idle.

PreviousValue

Variant. Gets the field previous value.

Read only

Can be read only when top-level Report object is formattiong active.

Prompt

String. Gets or sets the parameter field prompting string.

Read/Write

None

ReportName

String. Gets the report name the parameter field is in. If it is a main report, the ReportName is empty.

Read only

None

Value

Variant. Gets the current value of the field.

Read only

Can be read only when top-level Report object is formatting active.

ValueType

CRFieldValueType. Gets which type of value is found in the field.

Read only

None

Remarks


Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com